Line Test API
Test Data
The table below shows a list of product IDs. Most product IDs have been configured in the sandbox environment to return one simulated response for each test type. Use the test ID provided with GET test to obtain a test response of the specified test type.
The test response will always contain the product ID of the product the test is associated with for cross-referencing purposes.
Fibre Test Data
Product ID | ONT Status Test ID | RGW Bandwidth Test ID | Status Over Time Test ID | Optical Info Test ID |
1636535694 | CB07ZI77 | CB07ZI86 | CB07ZI84 | CB07ZI91 |
1636529551 | CB07ZJ06 | CB07ZJ07 | CB07ZJ08 | CC36GN89 |
1636406831 | CB99RO75 | CB99RO79 | CB99RO78 | CB99RO77 |
1636195285 | CB99RO95 | CB99RO97 | CB99RO98 | CB99RO94 |
1636109170 | CC36GN06 | CC36GN12 | CC36GN10 | CC36GN07 |
1636035701 | CC36GN30 | CC36GN33 | CC36GN35 | CC36GN55 |
1636259531 | CC36JY54 | CC36JY55 | CC36JY56 | CC36JY60 |
1636312394 | CC36JY90 | CC36JY96 | CC36JY94 | CC36JY92 |
1636094039 | CC36JZ08 | CC36JZ24 | CC36JZ10 | CC36JZ27 |
1636239530 | CC36JZ28 | CC36JZ30 | CC36JZ32 | CC36JZ33 |
1636483813 | CB07ZJ17 | CB07ZJ18 | CB07ZJ19 | CB07ZJ16 |
Fibre Sample Responses with Valid Payloads
The product IDs below will return valid response payloads for a GET product request, assuming the request is correctly formatted. These are stubbed sample responses. The product details in the response will match the details shown in the table.
Product ID | Plan | Bitstream | ATA Service Present | ONT Status | Services | UNI Port | Multiple ONT Connections | ONT Model | ONT Type | ONT Mode |
1636535694 | Home Fibre 300 | 2 | No | switched_off | Data only | 1 | No | G-140W-C | Type 300 | Standard |
1636529551 | NGA Evolve 1 | 2 | Yes | interrupted | Data and ATA | 1 | No | G-140W | Type 300 | Standard |
1636406831 | NGA Business 2 | 3 | No | reduced | Data only | 1 | No | G-240G-P | Type 200 | Standard |
1636195285 | Evolve - ATA | 2 | Yes | good | Voice Only | 2 | Yes | I-240G-R | Type 100 | Standard |
1636109170 | Evolve 100-20 S | 2 | No | reduced | Data Only | 2 | Yes | I-240G | Type 100 | Standard |
1636035701 | Education 4-S | 3a | No | good | Data Only | 2 | Yes | G-240G | Type 200 | Standard |
1636259531 | Evolve - ATA | 2 | Yes | good | Voice Only | 2 | Yes | I-240G | Type 100 | Standard |
1636312394 | Education 6 | 3a | No | unknown | Data Only | 1 | No | G-240G | Type 200 | Standard |
1636094039 | Evolve 100-20 S | 2 | No | good | Data Only | 3 | Yes | I-240G | Type 100 | Standard |
1636239530 | Evolve 100-50-2.5-2.5 S | 2 | No | good | Data Only | 4 | Yes | G-140W-C | Type 300 | Standard |
1636483813 | Home Fibre 920 | 2 | No | degraded | Data Only | 1 | No | G-240G | Type 200 | Standard |
Copper - DSL Test Data
The product IDs below will return valid response payloads for a GET product request (with 1 noted exception), assuming the request is correctly formatted. These are stubbed sample responses. They will also return valid response payloads for a GET test by product ID.
Product ID | Product | Fault Type / Line Variance | Line State Diagnosis Test ID | Line Quality Diagnosis Test ID (LQD tests cannot be created, only retrieved) |
1684607637 | EUBA | No DSL | CC50YK96 | - |
1690537123 | EUBA | LOW Sync | CC50YW32 | - |
1690509580 | VDSL | No DSL | CC50ZR45 | - |
1684863627 | VDSL | LOW Sync | CC50YK64 | CC50YK71 |
1634812490 | VDSL | Frequent dis | CC50YK49 | CC50YK23 CC99YK99**** |
1634351281 | EUBA | Frequent dis | CC51ET30 | - |
1684969075 | BUBA | No DSL | CC51ET50 | - |
1634962100 | BUBA | LOW Sync | CC53WJ81 | - |
1690926606 | BUBA | Frequent dis | CC53WY92 | - |
1684279336 | BUBA ATM | No DSL | CC53WY50 | - |
1684978694 | VDSL Boost | No DSL | CC51FH02 | - |
1684852033 | Boost qu | Qual yes | CC53WG55 | - |
1684840843 ** | Boost qu | Qual No | CC53WH82 | - |
**The GET product for this product ID will return a 203 – cached response. All other Product IDs will return a 200 – OK response.
***The GET test for this test ID is for a test that was created > 30 days ago. Only the metadata is returned.
Copper - BBIP Test Data
The product IDs below will return valid response payloads for a GET product request, with 1 noted exception, assuming the request is correctly formatted. These are stubbed sample responses. They will also return valid response payloads for a GET test by product ID.
Product ID | Line State | Nblt Single Line Test | Electrical Loop Test ID |
1617028721 | Good Line | CC53WZ06 | BY64GC97 |
1617012188** | Battery | CC53MX03 | BY64GC98 |
1617042530 | Earth | CC53TO20 | BY64GC97 |
32486997*** | Good Line | CC76MD04 | CC76MD14 |
73627890*** | Resistance Fault | CC76LV97 | CC76LV71 |
32486999*** | Battery | CC76LO78 | CC76LP66 |
**The GET product for this product ID will return a 203 – Cached response. All other Product IDs will return a 200 – OK response.
***These product IDs are POTS lines running over baseband IP. These lines will behave as baseband IP lines.
Sample Error Response
Alternative responses may be due to an alternative flow, such as an error scenario, cached data or in-flight processing where it is not possible to change a state, for example, posting a test. The product IDs and test IDs below will return emulations of some alternative responses. These are stubbed sample responses triggered by these specific IDs. You may encounter these responses with other data, however, we recommend you use these product IDs and test IDs to develop and test for these responses.
Product ID or Test ID | Request Type | Product Type | Test Type | Http Status Code | Notes |
1621212345 | GET Product | NGA | - | 503 | Connection error downstream |
1636123123 | GET Product | NGA | - | 500 | Downstream API exception |
1684852404 | GET Product | DSL | - | 404 | Product not found |
1684852500 | GET Product | DSL | - | 500 | Downstream API exception |
1617012404 | GET Product | BBIP | - | 404 | Product not found |
1617012500 | GET Product | BBIP | - | 500 | Downstream API exception |
1684607404 | POST Test | DSL | lineStateDiagnosis | 404 | Product not found |
1684607503 | POST Test | DSL | lineStateDiagnosis | 503 | Connection error downstream |
1684607500 | POST Test | DSL | lineStateDiagnosis | 500 | Downstream API exception |
1617607404 | POST Test | BBIP | nbltSingleLineTest or nbltElectricalLoopTest | 404 | Product not found |
1617607503 | POST Test | BBIP | nbltSingleLineTest or nbltElectricalLoopTest | 503 | Connection error downstream |
1617607500 | POST Test | BBIP | nbltSingleLineTest or nbltElectricalLoopTest | 500 | Downstream API exception |
BY64GC40 | GET Test | N/A | - | 404 | Test not found |
BY64GC50 | GET Test | N/A | - | 500 | Downstream API exception |
1617028500 | GET Tests by Product Id | BBIP | - | 400 | E.g. when the Count parameter > 20 |
1617028404 | GET Tests by Product Id | BBIP | - | 200 | Empty data set |
1684279500 | GET Tests by Product Id | DSL | - | 400 | E.g. when the Count parameter > 20 |
1684279404 | GET Tests by Product Id | DSL | - | 200 | Empty data set |
Sample Responses with Valid Payloads
See API Summary for sample responses.